/*
 * Copyright 2016 SimplifyOps, Inc. (http://simplifyops.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.dtolabs.rundeck.core.plugins;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;

/**
 * List and load resources from a plugin
 */
public interface PluginResourceLoader {

    /**
     * @return the list of resources available
     */
    public List<String> listResources() throws PluginException, IOException;

    /**
     * Open a stream to load a resource
     *
     * @param name resource path and name
     *
     * @return input stream for the resources, must be closed when finished, or null if the plugin does not support
     * resources
     *
     * @throws PluginException if a path is requested that was not in the plugin
     * @throws IOException     if an error occurs
     */
    InputStream openResourceStreamFor(String name) throws PluginException, IOException;
}
